Skip to content

adds doc suggestions made on issue 3666 #3668

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

adds doc suggestions made on issue 3666 #3668

wants to merge 1 commit into from

Conversation

@RobertKielty
Copy link

@RobertKielty RobertKielty commented Oct 21, 2025

Summary

Re-write of the BuiltIn APIs page to make it more explicit.

What Type of PR Is This?

/kind documentation

Related Issue(s)

Fixes #3666

Release Notes

NONE

@kcp-ci-bot kcp-ci-bot added release-note-none Denotes a PR that doesn't merit a release note. kind/documentation Categorizes issue or PR as related to documentation. dco-signoff: yes Indicates the PR's author has signed the DCO. labels Oct 21, 2025
@kcp-ci-bot
Copy link
Contributor

kcp-ci-bot commented Oct 21, 2025

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign xrstf for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@kcp-ci-bot kcp-ci-bot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 21, 2025
@kcp-ci-bot
Copy link
Contributor

kcp-ci-bot commented Oct 21, 2025

Hi @RobertKielty. Thanks for your PR.

I'm waiting for a kcp-dev member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@mjudeikis
Copy link
Contributor

mjudeikis commented Oct 24, 2025

/ok-to-test

@kcp-ci-bot kcp-ci-bot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Oct 24, 2025
@mjudeikis
Copy link
Contributor

mjudeikis commented Oct 24, 2025

Sorry, took as a bit to get to PR backlog

@mjudeikis mjudeikis self-requested a review October 24, 2025 06:57
mjudeikis
mjudeikis reviewed Oct 24, 2025
View reviewed changes
Copy link
Contributor

@mjudeikis mjudeikis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A few suggestions. Let me know what you think? Im on the fence with my own suggesions, and happy to discuss why you came up into this page in the first place to change it :)

docs/content/concepts/apis/built-in.md
kcp includes some, but not all, of the Kubernetes APIs.

## (core) v1
kcp does not make us of Kubernetes API endpoints that are concerned with orchestrating clusters and their workloads. Clusters dedicated to workload orchestration have these resources but kcp does not.
Copy link
Contributor

@mjudeikis mjudeikis Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this sounds bit of strange too.
I think we need to be more explicit:

kcp functions as a pure control plane, providing only a subset of the full Kubernetes API. It is not a complete Kubernetes distribution and intentionally excludes APIs related to running workloads.

Because kcp doesn't manage nodes or run containers, it lacks the necessary controllers and resource definitions for orchestration. Specifically, you will not find key resource types such as:

The apps API group (e.g., Deployments, StatefulSets, DaemonSets)
The core Pods resource
Networking resources like Services and Endpoints
You can find more details about the specific APIs kcp does support below.

docs/content/concepts/apis/built-in.md

## Kubernetes resources used by kcp

kcp makes use of these API Endpoints and resources to provide kcp features and indoing so leverages the Kubernetes Event Loop to manage non-cluster resources that can them be handles using conventions and tooling from the Kubernetes eco-system.
Copy link
Contributor

@mjudeikis mjudeikis Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This sentence sounds strange. Do we even need this if we detalized above?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mjudeikis mjudeikis mjudeikis left review comments

Assignees

No one assigned

Labels

dco-signoff: yes Indicates the PR's author has signed the DCO. kind/documentation Categorizes issue or PR as related to documentation. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. release-note-none Denotes a PR that doesn't merit a release note. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

docs: "BuiltIn APIs" page, title and layout suggestion.

3 participants

@RobertKielty @kcp-ci-bot @mjudeikis